Bypass the rendering differences in AsciiDoctor. AsciiDoctor have different understanding of [verse] with asciidoc, causing some rendering differences. To get similar result with asciidoc, we use something else instead of [verse] now. Screenshots: before: http://imgur.com/JKMdBiv after: http://imgur.com/yFVvVac Change-Id: I14e84f0e998e1e87b633681e8028ad657bde07e4
diff --git a/Documentation/rest-api-projects.txt b/Documentation/rest-api-projects.txt index c2e937a..4012f74 100644 --- a/Documentation/rest-api-projects.txt +++ b/Documentation/rest-api-projects.txt
@@ -12,8 +12,9 @@ [[list-projects]] List Projects ~~~~~~~~~~~~~ -[verse] +-- 'GET /projects/' +-- Lists the projects accessible by the caller. This is the same as using the link:cmd-ls-projects.html[ls-projects] command over SSH, @@ -97,8 +98,9 @@ [[get-project]] Get Project ~~~~~~~~~~~ -[verse] +-- 'GET /projects/link:#project-name[\{project-name\}]' +-- Retrieves a project. @@ -129,8 +131,9 @@ [[create-project]] Create Project ~~~~~~~~~~~~~~ -[verse] +-- 'PUT /projects/link:#project-name[\{project-name\}]' +-- Creates a new project. @@ -173,8 +176,9 @@ [[get-project-description]] Get Project Description ~~~~~~~~~~~~~~~~~~~~~~~ -[verse] +-- 'GET /projects/link:#project-name[\{project-name\}]/description' +-- Retrieves the description of a project. @@ -198,8 +202,9 @@ [[set-project-description]] Set Project Description ~~~~~~~~~~~~~~~~~~~~~~~ -[verse] +-- 'PUT /projects/link:#project-name[\{project-name\}]/description' +-- Sets the description of a project. @@ -234,8 +239,9 @@ [[delete-project-description]] Delete Project Description ~~~~~~~~~~~~~~~~~~~~~~~~~~ -[verse] +-- 'DELETE /projects/link:#project-name[\{project-name\}]/description' +-- Deletes the description of a project. @@ -260,8 +266,9 @@ [[get-project-parent]] Get Project Parent ~~~~~~~~~~~~~~~~~~ -[verse] +-- 'GET /projects/link:#project-name[\{project-name\}]/parent' +-- Retrieves the name of a project's parent project. For the `All-Projects` root project an empty string is returned. @@ -284,8 +291,9 @@ [[set-project-parent]] Set Project Parent ~~~~~~~~~~~~~~~~~~ -[verse] +-- 'PUT /projects/link:#project-name[\{project-name\}]/parent' +-- Sets the parent project for a project. @@ -318,8 +326,9 @@ [[get-head]] Get HEAD ~~~~~~~~ -[verse] +-- 'GET /projects/link:#project-name[\{project-name\}]/HEAD' +-- Retrieves for a project the name of the branch to which `HEAD` points. @@ -341,8 +350,9 @@ [[set-head]] Set HEAD ~~~~~~~~ -[verse] +-- 'PUT /projects/link:#project-name[\{project-name\}]/HEAD' +-- Sets `HEAD` for a project. @@ -374,8 +384,9 @@ [[get-repository-statistics]] Get Repository Statistics ~~~~~~~~~~~~~~~~~~~~~~~~~ -[verse] +-- 'GET /projects/link:#project-name[\{project-name\}]/statistics.git' +-- Return statistics for the repository of a project. @@ -408,8 +419,9 @@ [[get-config]] Get Config ~~~~~~~~~~ -[verse] +-- 'GET /projects/link:#project-name[\{project-name\}]/config' +-- Gets some configuration information about a project. Note that this config info is not simply the contents of `project.config`; it generally @@ -476,8 +488,9 @@ [[set-config]] Set Config ~~~~~~~~~~ -[verse] +-- 'PUT /projects/link:#project-name[\{project-name\}]/config' +-- Sets the configuration of a project. @@ -547,8 +560,9 @@ [[run-gc]] Run GC ~~~~~~ -[verse] +-- 'POST /projects/link:#project-name[\{project-name\}]/gc' +-- Run the Git garbage collection for the repository of a project. @@ -598,8 +612,9 @@ [[list-branches]] List Branches ~~~~~~~~~~~~~ -[verse] +-- 'GET /projects/link:#project-name[\{project-name\}]/branches/' +-- List the branches of a project. @@ -642,8 +657,9 @@ [[get-branch]] Get Branch ~~~~~~~~~~ -[verse] +-- 'GET /projects/link:#project-name[\{project-name\}]/branches/link:#branch-id[\{branch-id\}]' +-- Retrieves a branch of a project. @@ -671,8 +687,9 @@ [[create-branch]] Create Branch ~~~~~~~~~~~~~ -[verse] +-- 'PUT /projects/link:#project-name[\{project-name\}]/branches/link:#branch-id[\{branch-id\}]' +-- Creates a new branch. @@ -709,8 +726,9 @@ [[delete-branch]] Delete Branch ~~~~~~~~~~~~~ -[verse] +-- 'DELETE /projects/link:#project-name[\{project-name\}]/branches/link:#branch-id[\{branch-id\}]' +-- Deletes a branch. @@ -731,8 +749,9 @@ [[list-child-projects]] List Child Projects ~~~~~~~~~~~~~~~~~~~ -[verse] +-- 'GET /projects/link:#project-name[\{project-name\}]/children/' +-- List the direct child projects of a project. @@ -836,8 +855,9 @@ [[get-child-project]] Get Child Project ~~~~~~~~~~~~~~~~~ -[verse] +-- 'GET /projects/link:#project-name[\{project-name\}]/children/link:#project-name[\{project-name\}]' +-- Retrieves a child project. If a non-direct child project should be retrieved the parameter `recursive` must be set. @@ -873,8 +893,9 @@ [[list-dashboards]] List Dashboards ~~~~~~~~~~~~~~~ -[verse] +-- 'GET /projects/link:#project-name[\{project-name\}]/dashboards/' +-- List custom dashboards for a project. @@ -927,8 +948,9 @@ [[get-dashboard]] Get Dashboard ~~~~~~~~~~~~~ -[verse] +-- 'GET /projects/link:#project-name[\{project-name\}]/dashboards/link:#dashboard-id[\{dashboard-id\}]' +-- Retrieves a project dashboard. The dashboard can be defined on that project or be inherited from a parent project. @@ -1010,8 +1032,9 @@ [[set-dashboard]] Set Dashboard ~~~~~~~~~~~~~ -[verse] +-- 'PUT /projects/link:#project-name[\{project-name\}]/dashboards/link:#dashboard-id[\{dashboard-id\}]' +-- Updates/Creates a project dashboard. @@ -1066,8 +1089,9 @@ [[delete-dashboard]] Delete Dashboard ~~~~~~~~~~~~~~~~ -[verse] +-- 'DELETE /projects/link:#project-name[\{project-name\}]/dashboards/link:#dashboard-id[\{dashboard-id\}]' +-- Deletes a project dashboard. 